IsWindowInStandardState

IsWindowInStandardState
Header:	MacWindows.h		Carbon status:	Supported

Determines whether a window is currently zoomed in to the user state or zoomed out to the standard state.

Boolean IsWindowInStandardState (
    WindowRef window, 
    Point *idealSize, 
    Rect *idealStandardState
);

window: A pointer to the window for which you wish to determine the zoom state.
idealSize: Set the Point structure to contain the ideal width and height of the window’s content region, regardless of the actual screen device dimensions. If you set idealSize to NULL, IsWindowInStandardState examines the dimensions stored in the stdState field of the WStateData structure.
idealStandardState: On input, a pointer to a structure of type Rect. On return, the rectangle contains the global coordinates for the content region of the window in its standard state, based on the data supplied in the idealSize parameter. You may pass NULL if you do not wish to receive this data.

function result: true if the window is currently in its standard state; false if the window is currently in the user state.

DISCUSSION

The IsWindowInStandardState function compares the window’s current dimensions to those referred to by the idealSize parameter to determine if the window is currently in the standard state. Your application may use IsWindowInStandardState to decide whether a user’s click of the zoom box is a request to zoom to the user state or the standard state, as described in the function ZoomWindowIdeal. Your application may also use IsWindowInStandardState to determine the size and position of the standard state that the Window Manager would calculate for a window, given a specified ideal size; this value is produced in the idealStandardState parameter.

VERSION NOTES

This function is available with Mac OS 8.5 and later.

AVAILABILITY

Supported in Carbon. Available in CarbonLib 1.0 and later when WindowsLib 8.5 or later is installed. Exported by CarbonLib 1.0 and later and by WindowsLib 8.5 and later.